API Documentation
PixelFormat.h
1 // PixelFormat.h
3 //
5 
6 namespace nkImages
7 {
15  enum class PIXEL_FORMAT
16  {
17  UNKNOWN_FORMAT = 0,
18  R8G8B8,
19  R8G8B8A8,
20  B8G8R8,
21  B8G8R8A8,
22  R16G16B16A16,
23  R32G32B32,
24  R32G32B32A32,
25  } ;
26 
30  class PixelFormatUtils final
31  {
32  public :
33 
34  // Conversions
48  static unsigned int getFormatByteSize (PIXEL_FORMAT format) ;
57  static bool isFormatCompressed (PIXEL_FORMAT format) ;
64  static bool isFormatFloatingPoint (PIXEL_FORMAT format) ;
71  static bool hasAlpha (PIXEL_FORMAT format) ;
72  } ;
73 }
nkImages::PixelFormatUtils
Utility class to translate enum values into linked useful data.
Definition: PixelFormat.h:31
nkImages::PIXEL_FORMAT::R32G32B32
@ R32G32B32
Format is 3 channels Red Green Blue, each occupying 32 bits (4 bytes), floats.
nkImages::PIXEL_FORMAT::R8G8B8A8
@ R8G8B8A8
Format is 4 channels Red Green Blue Alpha, each occupying 8 bits (1 byte).
nkImages::PIXEL_FORMAT::B8G8R8A8
@ B8G8R8A8
Format is 4 channels Blue Green Red Alpha, each occupying 8 bits (1 byte).
nkImages::PIXEL_FORMAT::R16G16B16A16
@ R16G16B16A16
Format is 4 channels Red Green Blue Alpha, each occupying 16 bits (2 bytes), half floats.
nkImages::PixelFormatUtils::isFormatFloatingPoint
static bool isFormatFloatingPoint(PIXEL_FORMAT format)
nkImages::PIXEL_FORMAT::UNKNOWN_FORMAT
@ UNKNOWN_FORMAT
Format is unknown or not supported.
nkImages::PIXEL_FORMAT::R8G8B8
@ R8G8B8
Format is 3 channels Red Green Blue, each occupying 8 bits (1 byte).
nkImages::PixelFormatUtils::getFormatByteSize
static unsigned int getFormatByteSize(PIXEL_FORMAT format)
nkImages::PIXEL_FORMAT::B8G8R8
@ B8G8R8
Format is 3 channels Blue Green Red, each occupying 8 bits (1 byte).
nkImages
Encompasses all API of component NilkinsImages.
Definition: BmpEncoder.h:7
nkImages::PIXEL_FORMAT
PIXEL_FORMAT
Lists formats for pixels.
Definition: PixelFormat.h:16
nkImages::PixelFormatUtils::isFormatCompressed
static bool isFormatCompressed(PIXEL_FORMAT format)
nkImages::PixelFormatUtils::hasAlpha
static bool hasAlpha(PIXEL_FORMAT format)
nkImages::PIXEL_FORMAT::R32G32B32A32
@ R32G32B32A32
Format is 4 channels Red Green Blue Alpha, each occupying 32 bits (4 bytes), floats.
nkImages::PixelFormatUtils::getRgbFromBgrFormat
static PIXEL_FORMAT getRgbFromBgrFormat(PIXEL_FORMAT format)